Skip to content

Strengthen warning against using 'import *' in tutorial #137011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

Strengthen warning against using 'import *' in tutorial #137011

wants to merge 2 commits into from

Conversation

@yusuaois
Copy link

@yusuaois yusuaois commented Jul 22, 2025 •
edited by github-actions bot
Loading

trivial fix:
In Doc/tutorial/modules.rst, the current wording about import * usage is not sufficiently strong:

- "However, it is okay to use it to save typing in interactive sessions."

This phrasing has two main issues:

- Understates risks: Framing it as "okay" minimizes the potential problems with wildcard imports

- Incomplete guidance: Fails to explicitly warn against using this pattern in production code

- Ambiguous justification: "Save typing" implies convenience is the primary consideration, ignoring namespace pollution risks

📚 Documentation preview 📚: https://cpython-previews--137011.org.readthedocs.build/

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 22, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jul 22, 2025
@AA-Turner
Copy link
Member

The current wording is fine. Please also read our AI policy.

A

@AA-Turner AA-Turner closed this Jul 22, 2025
@yusuaois yusuaois deleted the document branch July 23, 2025 00:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@yusuaois @AA-Turner @StanFromIreland